12.1 Introdução
O objeto WebHook é o cadastro de um endpoint que será chamado quando um evento específico ocorrer. O endpoint pode ser chamado para notificar sobre eventos de interesse da empresa, como por exemplo, alterações cadastrais de responsáveis financeiros ou dependentes e mudança de status ou valores de boletos e planos de pagamentos.
| Campo | Tipo | Descrição |
|---|---|---|
| active | Boolean! | Status de Ativação |
| changes | [LogHistory!]! | Histórico de alterações |
| company | Company! | Dados da empresa |
| companyId | Int! | Id da empresa |
| creationDate | DateTime! | Data de Criação |
| deleted | Boolean! | Status de Deleção |
| environmentType | EnvironmentType! | Tipo do ambiente |
| events | [WebHookEvent!] | Lista de webhooks executados |
| eventTypes | [OriginType!]! | Tipos de eventos que serão associados |
| externalId | Int | Id Externo |